Shipments Order
Inbound or Outbound shipments may be scheduled in and out of Equinix Data Centers. The user must have Shipments ordering permissions for the specific Data Center locations. Additional fees may be applied for deliveries during non-business hours (after hours or weekend deliveries) which will require prior approval and will be billed to your account as an Equinix SmartHands fee. SmartHands fees will also apply for Equinix to deliver the package(s) to your cage or suite. Inbound shipments must be picked up within 5 days of delivery. After 5 days, if all attempts to contact the customer results in no response, further action will be taken. Please refer to Global IBX Policies for additional details. For international Outbound shipments, all customs paperwork must be provided. Equinix will not act as the importer of goods and is not responsible for working with local customs.
For a summary of Shipping and Receiving procedures and information, see 'Inbound/ Outbound Shipping' in Equinix Smart Hands™ Welcome Guide.
For more information on Equinix Data Center policies, see Global IBX Policies
See Integrate with Equinix Messaging Gateway for links on how to use the EMG Templates for ordering.
Equinix Messaging Gateway currently supports 2 Inbound and Outbound shipment types. The below Operation Code and Service attributes are passed in the request payload to indicate the shipment type.
| Shipments Type | Operation | Service Details Attribute | Mandatory/Optional | Type | Example | |
| Category | Sub-Category | |||||
| Inbound - Carrier | 0000 | 0000 | NoOfBoxes | Optional | Integer | 1 (min) - 10000000000000000000(max); Default = 1 |
| DeliverToCage | Optional | Boolean | Expected Values: true, false; Default = false | |||
| Inbound - Customer Carry | 0000 | 0001 | NoOfBoxes | Optional | Integer | 1 (min) - 10000000000000000000(max); Default = 1 |
| DeliverToCage | Optional | Boolean | Expected Values: true, false; Default = false |
|||
| Outbound- Carrier | 0001 | 0000 | NoOfBoxes | Optional | Integer | 1 (min) - 10000000000000000000(max); Default = 1 |
| DeliverToCage | Optional | Boolean | Expected Values: true, false; Default = false |
|||
| DeclaredValue | Mandatory if no shipping label exist. | String | min Length: 1, max length: 20 Ex: $3000USD |
|||
| ShipmentDescription | Optional | String | min Length: 1, max length: 100 Ex: "Router" |
|||
| ShipToName | Mandatory if no shipping label exist. | String | min Length: 1, max length: 100 Ex: "Contoso Ltd" |
|||
| ShipToAddress | Mandatory if no shipping label exist. | String | min Length: 1, max length: 100 Ex: "Demo address" |
|||
| ShipToCity | Mandatory if no shipping label exist. | String | min Length: 1, max length: 100 Ex: "Cupertino" |
|||
| ShipToState | Mandatory if no shipping label exist. | String | min Length: 1, max length: 100 Ex: "CA" |
|||
| ShipToCountry | Mandatory if no shipping label exist. | String | min Length: 1, max length: 100 Ex: "USA" |
|||
| ShipToZipCode | Mandatory if no shipping label exist. | String | min Length: 1, max length: 100 Ex: "93451" |
|||
| ShipToPhoneNumber | Mandatory if no shipping label exist. | String | min Length: 1, max length: 20 Ex: "+1 408 555 1234" |
|||
| ShipToCarrierAccountNumber | Mandatory if no shipping label exist. | String | min Length: 1, max length: 100 Ex: "636367838" |
|||
| InsureShipment | Optional | Boolean | Expected Values: true, false; Default = false |
|||
| PickUpFromCageSuite | Optional | Boolean | Expected Values: true, false; Default = false False (Default) | |||
| Outbound - CUSTOMER CARRY | 0001 | 0001 | NA | NA | NA | NA |
The following screenshots show sample message requests to create, update, and cancel shipments in EMG.
Create Shipments
Sample Request:
{
"Task": {
"Id": "bf9f2707-d612-4d63-9958-4c8b1fcf3cc0",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Create",
"Resource": "Shipping",
"ContentType": "application/json",
"Version": "1.0",
"Body": {
"RequestorId": "123456789",
"RequestorIdUnique": false,
"Operation": "0001/0000",
"Description": "Create Shipment Order",
"Attachments": [
{
"Name": "samplepicture.jpeg",
"Url": "https://eqixazurestorage.blob.core.windows.net/file-download-blob/samplepicture.jpeg"
}
],
"Location": "LD8:00:000000",
"CustomerContact": "demo@equinix.com",
"ShipmentDateTime": "2019-12-20T18:25:43.511Z",
"ShipmentLabelInsideBox": true,
"CarrierName": "Demo Carrier",
"ShipmentIdentifier": "MI1D5ABCD"
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}The description of the create request schema is as follows:
| Name | Mandatory | Type | Applicable Value(s) | Description |
|---|---|---|---|---|
| Task | Yes | Object | The task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order. | |
| ID | Yes | String (Guid) | The unique identifier of the message. Customers must ensure to send a unique value for each message. | |
| Source | Yes | String (Guid) | A unique value to identify the message sender. This value will be shared with the customer during the onboarding process. | |
| Verb | Yes | String | Create | Indicates the action to be performed. |
| Resource | Yes | String | Shipping | Indicates the order type. |
| ContentType | No | String | application/json | |
| Version | Yes | String | 1.0 | The version of the request and response schema. |
| Body | Yes | Object | An object containing the details of the order. The attributes within the object will vary based on the resource and verb. | |
| RequestorId | Conditional | String | The customer's reference number for this Shipments order. This attribute is only mandatory if RequestorIdUnique is true. | |
| RequestorIdUnique | Yes | Boolean | true false |
Indicates whether the RequestorId is unique. The default value for this attribute
is false. The RequestorId should not be referenced in any other ticket and if referenced this operation will fail with a "400 - Bad Request". This field cannot be NULL. |
| Operation | Yes | String | Indicates the Shipment type. For example, 0004/0000, where 0004 is the category and 0000 is the operation subcategory. |
|
| Location | Yes | String | The location of the cage and cabinet where the Shipment order is requested. | |
| CustomerContact | Yes | String | The username or email address of the user registered with Equinix Customer Portal. CustomerContact is mandatory if "Verb" is create. | |
| ShipmentDateTime | Yes | String |
Indicates the shipment time in ISO UTC DateTime Format. For Inbound shipments, it is the local date and time of the Equinix site that would be receiving the shipment. For Outbound shipment, it is the local date and time of the Equinix site that would be shipping out the shipment. |
|
| ShipmentLabelInsideBox | No | Boolean |
Indicates if there is a shipping label is provided inside the box for this shipment. Required only if operation code is 0001-0000 |
|
| ShipmentLabel | No | Object |
An object containing the shipping label attachment details. This attribute is only mandatory if operation code is 0001/0000 and ShipmentLabelInsideBox is FALSE and Service Details are NULL. Shipment label is limited to 1 label only |
|
| ShipmentIdentifier | No | String |
Provide Shipment Tracking Number as ShipmentIdentifier. Equinix Limits to 1 Tracking Number. This attribute is only mandatory if the operation code is 0000/0000 and 0001/0000. For Operation Code 0000-0000: For Operation Code 0001-0000: - If ShipmentIdentifier is COMING IN REQUEST BUT AS NULL or EMPTY, & ShipmentLabelInsideBox is TRUE, then Equinix EMG service will default ShipmentIdentifier to "Shipment Label Inside Box" - If ShipmentIdentifier is NOT COMING IN REQUEST & ShipmentLabelInsideBox is TRUE, then Equinix EMG service will default ShipmentIdentifier to "ShipmentLabelInsideBox" - If ShipmentLabelInsideBox is FALSE, then ShipmentIdentifier is MANDATORY else EMG will throw 400 Bad Request - If the shipment label is not found in the box, 2-way comm gets initiated from Equinix IBX Tech |
|
| ServiceDetails | No | String | This attribute is only mandatory if operation code is 0001/0000 and ShipmentLabelInsideBox
is FALSE and ShipmentLabel is not provided. Refer to Operation and Service Details above. |
|
| CarrierName | No | String | The name of the carrier service. This attribute is only mandatory if the operation code is 0000/0000 and 0001/0000. | |
| Description | No | String |
A detailed description of the scope of work. |
|
| Attachments | No | Array [{ String, String }] |
Includes all attachments for supporting this request. Expected Value: [{"Name":<Attachment_Name>, "Url":<Attachment_URL>}] OR [{"Name":<Attachment_Name>, "Id":<Attachment_Id>}] URL - URL to download the attachment 5 files with 5MB size each Supported filetypes: .bmp,.jpeg,.jpg,.gif,.png,.tif,.txt,.doc,.docx,.xls,.tiff,.xlsx,.ppt,.pptx,.pdf,.vsd,.pps,.ppsx |
|
| AdditionalContacts | No | Array [{ Object}] | Can be used to overide details of TECHNICAL CONTACT sent as part of "CustomerContact" attribute. You can send details of non-registered contacts with Equinix Customer Portal | |
| ContactType | Yes | String (Enum) | Type of Contact. Expected value : TECHNIICAL | |
| Name | Yes | String | Full Name of the Contact, Eg. 'First_Name' + 'Last_Name' Supported Regex: ^[\s.]([^\s.][\s.]){0,100}$ |
|
| Yes | String | Valid email address of the contact. Should be <=100 characters Supported Regex: ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$ |
||
| WorkPhoneCountryCode | Yes | String | Country Code of Primary Phone of the contact. Should be within [1…6] characters
Supported Regex: ^\+[0-9]{1,6}$ |
|
| WorkPhone | Yes | String | Primary Phone of the contact. Should be within [1…40] characters Supported Regex: ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,10})?$ |
|
| WorkPhonePrefToCall | No | String | Expected values are NEVER, ANYTIME, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. Defauted to 'ANYTIME' | |
| WorkPhoneTimeZone | No | String | Expected values are "Atlantic/Canary" "Europe/Dublin" "Europe/London" "Europe/Lisbon" "Africa/Algiers" "Europe/Berlin" "Europe/Amsterdam" "Europe/Copenhagen" "Europe/Madrid" "Europe/Paris" "Europe/Stockholm" "Europe/Zurich" "Europe/Warsaw" "Africa/Cairo" "Africa/Johannesburg" "Europe/Sofia" "Africa/Nairobi" "Asia/Jerusalem" "Europe/Istanbul" "Europe/Moscow" "Asia/Riyadh" "Asia/Dubai" "Asia/Kabul" "Asia/Tehran" "Asia/Karachi" "Indian/Maldives" "Asia/Kolkata" "Asia/Kathmandu" "Asia/Omsk" "Asia/Rangoon" "Asia/Jakarta" "Asia/Ho_Chi_Minh" "Asia/Brunei" "Asia/Hong_Kong" "Asia/Kuala_Lumpur" "Asia/Manila" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Australia/Perth" "Asia/Seoul" "Asia/Tokyo" "Australia/Darwin" "Australia/Brisbane" "Pacific/Guam" "Australia/Adelaide" "Australia/Sydney" "Pacific/Auckland" "Pacific/Chatham" "Indian/Christmas" "America/Scoresbysund" "Atlantic/South_Georgia" "America/Sao_Paulo" "America/Detroit" "America/New_York" "America/Puerto_Rico" "America/Toronto" "America/Bogota" "America/Chicago" "America/Winnipeg" "America/Denver" "America/Edmonton" "America/Mexico_City" "America/Los_Angeles" "America/Vancouver" "America/Phoenix" "America/Anchorage" "Pacific/Gambier" "Pacific/Marquesas" "Pacific/Honolulu" "Pacific/Fiji" "Asia/Muscat" "America/Argentina/Buenos_Aires" "America/Caracas" "Etc/GMT+12" "UTC" "GMT" "America/Santiago" "America/St_Johns" "Asia/Almaty" "Asia/Bankgkok" "Asia/Calcutta" "Asia/Magadan" "Asia/Yekaterinburg" "Australia/Eucla" "Australia/Lord_Howe" "Europe/Bratislava" "Europe/Brussels" "Europe/Prague" "Europe/Rome" "Pacific/Kiritimati" "Pacific/Midway" "Pacific/Tongatapu" | |
| MobilePhoneCountryCode | No | String | Country Code of Mobile Phone of the contact. Should be within [1…6] characters Supported Regex: ^\+[0-9]{1,6}$ |
|
| MobilePhone | No | String | Mobile Phone of the contact. Should be within [1…40] characters Supported Regex: ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,10})?$ |
|
| MobilePhonePrefToCall | No | String | Expected values are NEVER, ANYTIME, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. Defauted to 'ANYTIME' | |
| MobilePhoneTimeZone | No | String | Please refer to 'WorkPhoneTimeZone' for expected values | |
| Signature | Yes | String | Base64 encoded signature. |
{
"Task": "{\"Id\":\"69352cff-4f00-4c42-9dce-a1b5e5ecc40b\",\"Source\":\"3e095d30-40ff-11e9-8959-5be078353003\",\"Verb\":\"Ack\",\"Resource\":\"Shipping\",\"ContentType\":\"application/json\",\"CreateTimeUTC\":\"2019-12-13T15:45:04.553Z\",\"Version\":\"1.0\",\"OriginationId\":\"bf9f2707-d612-4d63-9958-4c8b1fcf3cc0\",\"OriginationVerb\":\"Create\",\"Body\":{\"RequestorId\":\"123456789\",\"ServicerId\":\"1-199912345789\",\"StatusCode\":201,\"Description\":\"Equinix Shipments: 1-199912345789 Was created in reference to : 123456789\",\"Object\":null}}",
"Signature": "Jm2BpG/5ll6s3v0w3WWMULkRXsIEPog1e5AuYWT/kF3qW+hhNAFDZGCJ5lNmUT4Y3jUFid/3yb3diXK+Tr0hm7zwGLMDyi/mRwlc7LxYKRtbhHgHxWviQgTsLrreKlLuOJHbl81bCLxK2UEPrfRXuAOUbMyOT2mzBhidiCFg=="
}The description of the create response schema is as follows:
| Name | Type | Description |
|---|---|---|
| Task | Object | The task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order. |
| ID | String (Guid) | The unique identifier of the message. Customers must ensure to send a unique value for each message. |
| Source | String (Guid) | A unique value to identify the message sender. This value will be shared with the customer during the onboarding process. |
| Verb | String | Indicates the action to be performed. The verb for response messages is "Ack". |
| Resource | String | Indicates the order type. |
| ContentType | String | |
| CreateTimeUTC | String | Indicates the date and time at which the Shipment order was created at Equinix's end. |
| Version | String | The version of the request and response schema. |
| Body | Object | An object containing the details of the order. The attributes within the object will vary based on the resource and verb. |
| RequestorId | String | The customer's reference number for this Shipments order. |
| ServicerId | String | Indicates the Shipments order ID generated by Equinix after the order was submitted. |
| StatusCode | String | The HTTP status code of the request. |
| Description | String | Additional details of the order created Ex: "Equinix Shipments: 1-199912345789 Was created in reference to : 123456789" |
| Signature | String | Base64 encoded signature. |
Update Shipments
Sample Request:
{
"Task": {
"Id": "2352c576-fab3-4856-a431-0a4b55a2babe",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Update",
"Resource": "Shipping",
"ContentType": "application/json",
"Version": "1.0",
"Body": {
"ServicerId": "1-199912345789",
"Attachments": [
{
"Name": "samplepicture.jpeg",
"Url": "https://eqixazurestorage.blob.core.windows.net/file-download-blob/samplepicture.jpeg"
}
],
"Description": "Update Shipment Order"
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}The description of the update request schema is as follows:
| Name | Mandatory | Type | Applicable Value(s) | Description |
|---|---|---|---|---|
| Task | Yes | Object | The task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order. | |
| ID | Yes | String (Guid) | The unique identifier of the message. Customers must ensure to send a unique value for each message. | |
| Source | Yes | String (Guid) | A unique value to identify the message sender. This value will be shared with the customer during the onboarding process. | |
| Verb | Yes | String | Update | Indicates the action to be performed. |
| Resource | Yes | String | Shipping | Indicates the order type. |
| ContentType | No | String | application/json | |
| Version | Yes | String | 1.0 | The version of the request and response schema. |
| Body | Yes | Object | An object containing the details of the order. The attributes within the object will vary based on the resource and verb. | |
| RequestorId | Conditional | String | The customer's reference number for this Shipments order. This attribute is only mandatory if ServicerId is not provided. | |
| ServicerId | Conditional | String | Indicates the Shipment order ID generated by Equinix after the order was submitted. This attribute is only mandatory if RequestorId is not provided. | |
| ShipmentDateTime | No | String |
Indicates the shipment time in ISO UTC DateTime Format. For Inbound shipments, it is the local date and time of the Equinix site that would be receiving the shipment. For Outbound shipment, it is the local date and time of the Equinix site that would be shipping. |
|
| ShipmentLabelInsideBox | No | Boolean |
Indicates if there is a shipping label is provided inside the box for this shipment. This attribute is supported only for operation code 0001-0000 A NULL value cannot be sent for this attribute. |
|
| ShipmentLabel | No | Object |
An object containing the shipping label attachment details. This attribute is supported only for operation code is 0001/0000 and ShipmentLabelInsideBox is FALSE and Service Details are NULL. Shipment label is limited to 1 label only. |
|
| ShipmentIdentifier | No | String |
Provide Shipment Tracking Number as ShipmentIdentifier. Equinix Limits to 1 Tracking Number. This attribute is supported only for operation code 0000-0000 & 0001-0000 For Operation Code 0000-0000: For Operation Code 0001-0000: - If ShipmentIdentifier is COMING IN REQUEST BUT AS NULL or EMPTY, & ShipmentLabelInsideBox is TRUE, then Equinix EMG service will default ShipmentIdentifier to "Shipment Label Inside Box" - If ShipmentIdentifier is NOT COMING IN REQUEST & ShipmentLabelInsideBox is TRUE, then Equinix EMG service will default ShipmentIdentifier to "ShipmentLabelInsideBox" - If ShipmentLabelInsideBox is FALSE, then ShipmentIdentifier is MANDATORY else EMG will throw 400 Bad Request - If the shipment label is not found in the box, 2-way comm gets initiated from Equinix IBX Tech |
|
| ServiceDetails | No | String | This attribute is supported only for operation code 0001/0000 and ShipmentLabelInsideBox is
FALSE and ShipmentLabel is not provided. Refer to Operation and Service Details above. |
|
| CarrierName | No | String |
The name of the carrier service. This attribute is supported only for the operation code 0000/0000 and 0001/0000. |
|
| Description | Yes | String | A detailed description of the scope of work. This field can only be up to 3800 characters long. |
|
| Attachments | No | Array [{ String, String }] |
Includes all attachments for supporting this request. Expected Value: [{"Name":<Attachment_Name>, "Url":<Attachment_URL>}] 5 files with 5MB size each Supported filetypes: .bmp,.jpeg,.jpg,.gif,.png,.tif,.txt,.doc,.docx,.xls,.tiff,.xlsx,.ppt,.pptx,.pdf,.vsd,.pps,.ppsx |
|
| Signature | Yes | String | Base64 encoded signature. |
Sample Response:
{
"Task": "{\"Id\":\"69352cff-4f00-4c42-9dce-a1b5e5ecc40b\",\"Source\":\"3e095d30-40ff-11e9-8959-5be078353003\",\"Verb\":\"Ack\",\"Resource\":\"Shipping\",\"ContentType\":\"application/json\",\"CreateTimeUTC\":\"2019-12-13T15:45:04.553Z\",\"Version\":\"1.0\",\"OriginationId\":\"bf9f2707-d612-4d63-9958-4c8b1fcf3cc0\",\"OriginationVerb\":\"Update\",\"Body\":{\"RequestorId\":\"123456789\",\"ServicerId\":\"1-199912345789\",\"StatusCode\":201,\"Description\":\"Equinix Shipments: 1-199912345789 was updated\",\"Object\":null}}",
"Signature": "Jm2BpG/5ll6s3v0w3WWMULkRXsIEPog1e5AuYWT/kF3qW+hhNAFDZGCJ5lNmUT4Y3jUFid/3yb3diXK+Tr0hm7zwGLMDyi/mRwlc7LxYKRtbhHgHxWviQgTsLrreKlLuOJHbl81bCLxK2UEPrfRXuAOUbMyOT2mzBhidiCFg=="
}The description of the update response schema is as follows:
| Name | Type | Description |
|---|---|---|
| Task | Object | The task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order. |
| ID | String (Guid) | The unique identifier of the message. Customers must ensure to send a unique value for each message. |
| Source | String (Guid) | A unique value to identify the message sender. This value will be shared with the customer during the onboarding process. |
| Verb | String | Indicates the action to be performed. The verb for response messages is "Ack". |
| Resource | String | Indicates the order type. |
| ContentType | String | |
| CreateTimeUTC | Indicates the date and time at which the Shipment order was updated at Equinix's end. | |
| Version | String | The version of the request and response schema. |
| OriginationId | String (Guid) | The ID of the origination message, the value will be Null for an initial message. |
| OriginationVerb | String | The action to be performed by Equinix, the value will be Null for an initial message. |
| Body | Object | An object containing the details of the order. The attributes within the object will vary based on the resource and verb. |
| RequestorId | String | The customer's reference number for this Shipment order. |
| ServicerId | String | Indicates the Shipment order ID generated by Equinix after the order was submitted. |
| StatusCode | String | The HTTP status code of the request. |
| Description | String |
Additional details of the order updated. Ex: "Equinix Shipments: 1-199912345789 was updated" |
| Signature | String | Base64 encoded signature. |
Cancel Shipments
Sample Request:
{
"Task": {
"Id": "63d7a57b-848a-4335-ab47-6c1aaee71b04",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Update",
"Resource": "Shipping",
"ContentType": "application/json",
"Version": "1.0",
"Body": {
"State": "Cancelled",
"ServicerId": "1-199912345789",
"Description": "Cancel Shipment Order"
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}The description of the cancel request schema is as follows:
| Name | Mandatory | Type | Applicable Values | Description |
|---|---|---|---|---|
| Task | Yes | Object | The task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order. | |
| ID | Yes | String (Guid) | The unique identifier of the message. Customers must ensure to send a unique value for each message. | |
| Source | Yes | String (Guid) | A unique value to identify the message sender. This value will be shared with the customer during the onboarding process. | |
| Verb | Yes | String | Update | Indicates the action to be performed. |
| Resource | Yes | String | Shipping | Indicates the order type. EMG currently supports 4 order types. |
| ContentType | No | String | application/json | |
| Version | Yes | String | 1.0 | The version of the request and response schema. |
| Body | Yes | Object | An object containing the details of the order. The attributes within the object will vary based on the resource and verb. | |
| State | Conditional | String | Cancelled | This attribute is only valid when the verb is 'Update' and must only be used when cancelling an order. |
| RequestorId | Conditional | String | The customer's reference number for this Shipments order. This attribute is only mandatory if ServicerId is not provided. | |
| ServicerId | Conditional | String | Indicates the Shipment order ID generated by Equinix after the order was submitted. This attribute is only mandatory if RequestorId is not provided. | |
| Description | Yes | String | A detailed description of the scope of work. This field can only be up to 3800 characters long. |
|
| Signature | Yes | String | Base64 encoded signature. |
Sample Response:
{
"Task": "{\"Id\":\"2f3b9c69-1446-46fa-b5c7-040421029c88\",\"Source\":\"3e095d30-40ff-11e9-8959-5be078353003\",\"Verb\":\"Ack\",\"Resource\":\"Shipping\",\"ContentType\":\"application/json\",\"CreateTimeUTC\":\"2019-12-13T15:53:33.084Z\",\"Version\":\"1.0\",\"OriginationId\":\"63d7a57b-848a-4335-ab47-6c1aaee71b04\",\"OriginationVerb\":\"Update\",\"Body\":{\"ServicerId\":\"1-199912345789\",\"RequestorId\":\"123456789\",\"StatusCode\":200,\"Description\":\"Equinix Shipments: 1-199912345789 Was Cancelled\",\"Object\":[{\"Name\":\"cancelticket.jpeg\",\"Id\":\"f1797cd8-4508-434d-9998-3cf4545c7ca0\"}]}}",
"Signature": "Jm2BpG/5ll6s3v0w3WWMULkRXsIEPog1e5AuYWT/kF3qW+hhNAFDZGCJ5lNmUT4Y3jUFid/3yb3diXK+Tr0hm7zwGLMDyi/mRwlc7LxYKRtbhHgHxWviQgTsLrreKlLuOJHbl81bCLxK2UEPrfRXuAOUbMyOT2mzBhidiCFg=="
}The description of the cancel response schema is as follows:
| Name | Type | Description |
|---|---|---|
| Task | Object | The task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order. |
| ID | String (Guid) | The unique identifier of the message. Customers must ensure to send a unique value for each message. |
| Source | String (Guid) | A unique value to identify the message sender. This value will be shared with the customer during the onboarding process. |
| Verb | String | Indicates the action to be performed. The verb for response messages is "Ack". |
| Resource | String | Indicates the order type. EMG currently supports 4 order types. |
| ContentType | String | |
| CreateTimeUTC | Indicates the date and time at which the Shipments order was cancelled at Equinix's end. | |
| Version | String | The version of the request and response schema. |
| Body | Object | An object containing the details of the order. The attributes within the object will vary based on the resource and verb. |
| RequestorId | String | The customer's reference number for this Shipment order. |
| ServicerId | String | Indicates the Shipments order ID generated by Equinix after the order was submitted. |
| StatusCode | String | The HTTP status code of the request. |
| Description | String |
Additional details of the order cancelled. Ex: "Equinix SmartHands: 1-199912345789 Was Cancelled" |
| Signature | String | Base64 encoded signature. |
Sample Outgoing Notification
For more information, refer to Order Notifications - Shipments.
